Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add auto-generation of JSON schema. #478

Merged
merged 2 commits into from
Feb 22, 2022
Merged

Add auto-generation of JSON schema. #478

merged 2 commits into from
Feb 22, 2022

Conversation

XAMPPRocky
Copy link
Collaborator

@XAMPPRocky XAMPPRocky commented Jan 31, 2022

This commit adds support for Quilkin to generate JSON schema for any of the included filters, and adds some glue to make it so that these schemas are automatically included in the mdBook documentation.

Additionally to work with mdbook, the -q/--quiet flag was added to run Quilkin in silent mode.

There's still some improvements to be made for some of the special items, but this is already much better IMO than having to maintain these configurations by hand.

Breaking Changes

(these are mostly changes to better accept config now with the change to a derive macro for the CLI, which makes it easier to accept and validate types like PathBuf)

  • runner::run_with_config has been removed and runner::run now accepts a Config argument.
  • Config::find has been removed and functionality has been moved into the binary directly. This is to make it easier to move the environment handling to clap.
  • --config now comes before the command.
  • Added new required method config_schema to FilterFactory.

@XAMPPRocky XAMPPRocky force-pushed the auto-schema branch 3 times, most recently from 6a2d15e to 02a17fe Compare February 1, 2022 08:55
@XAMPPRocky XAMPPRocky added the kind/breaking Changes to functionality, API, etc. label Feb 1, 2022
@XAMPPRocky XAMPPRocky mentioned this pull request Feb 1, 2022
@XAMPPRocky XAMPPRocky force-pushed the auto-schema branch 4 times, most recently from a4dfa77 to b8dd915 Compare February 3, 2022 17:13
@markmandel

This comment was marked as resolved.

[preprocessor.links]
after = ["quilkin"]

[preprocessor.quilkin]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is magic 🪄

docs/preprocessor.sh Show resolved Hide resolved
docs/src/using.md Outdated Show resolved Hide resolved
docs/src/quickstart-agones-xonotic.md Show resolved Hide resolved
@github-actions github-actions bot added size/l and removed size/m labels Feb 7, 2022
@XAMPPRocky XAMPPRocky force-pushed the auto-schema branch 2 times, most recently from b013ea1 to 73adf2b Compare February 7, 2022 09:51
@XAMPPRocky
Copy link
Collaborator Author

@markmandel Can't figure out the CI failure here. That (Makefile:120) is the archive_dependencies.sh script FWIW.

Step 3/13 : WORKDIR /
make: *** [Makefile:120: build-image] Terminated

@markmandel
Copy link
Member

markmandel commented Feb 22, 2022

@markmandel Can't figure out the CI failure here. That (Makefile:120) is the archive_dependencies.sh script FWIW.

Yeah, that's a weird one. Lemme take a peek, see what's up.

@markmandel
Copy link
Member

Ah found it - if we look at the whole log, we see as:

TIMEOUT
ERROR: context deadline exceeded

Which is hidden at the step level.

Cloud Build is set to 30m build time (at some point we should dig into why each step keeps re-downloading and compiling - thought that volume was shared between builds).

I'll send a PR to bump it to 2h.

@XAMPPRocky XAMPPRocky force-pushed the auto-schema branch 2 times, most recently from 26cf1df to 81866eb Compare February 22, 2022 17:31
This commit adds support for Quilkin to generate JSON schema for any of
the included filters, and adds some glue to make it so that these
schemas are automatically included in the mdBook documentation.
@quilkin-bot
Copy link
Collaborator

Build Succeeded 🥳

Build Id: 5a0a3e96-5b48-4cc3-bb9f-9ccea390b299

To build this version:

git fetch [email protected]:googleforgames/quilkin.git pull/478/head:pr_478 && git checkout pr_478
cargo build

@markmandel markmandel merged commit ea72509 into main Feb 22, 2022
@markmandel markmandel deleted the auto-schema branch February 22, 2022 19:50
@markmandel markmandel added kind/feature New feature or request kind/documentation Improvements or additions to documentation labels Feb 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/breaking Changes to functionality, API, etc. kind/documentation Improvements or additions to documentation kind/feature New feature or request size/l
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants